/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.admin;

/**
 * 一个用于通过 JMX 控制和监控正在运行的 {@code SpringApplication} 的 MBean 接口。
 * 仅供内部使用。
 *
 * @author Stephane Nicoll
 * @since 1.3.0
 */
public interface SpringApplicationAdminMXBean {

	/**
	 * 指示应用程序是否已完全启动并准备就绪。
	 * @return 如果应用已准备好，则返回 {@code true}
	 * @see org.springframework.boot.context.event.ApplicationReadyEvent
	 */
	boolean isReady();

	/**
	 * 指示应用程序是否运行在嵌入式 Web 容器中。
	 * 对于尚未完全启动的 Web 应用程序将返回 {@code false}，
	 * 因此建议等待应用程序 {@link #isReady() ready} 之后再操作。
	 * @return 如果应用程序运行在嵌入式 Web 容器中，则返回 {@code true}
	 * @see #isReady()
	 */
	boolean isEmbeddedWebApplication();

	/**
	 * 从应用程序的 {@link org.springframework.core.env.Environment Environment}
	 * 中返回指定键的值。
	 * @param key 属性键
	 * @return 属性值，如果不存在则返回 {@code null}
	 */
	String getProperty(String key);

	/**
	 * 关闭应用程序。
	 * @see org.springframework.context.ConfigurableApplicationContext#close()
	 */
	void shutdown();

}
